/*
 * MIT License
 *
 * Copyright (c) 2025 Mark·虎
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * 该包下主要包含国际化资源服务相关的接口和实现类。
 * 此包中的代码负责处理国际化资源的管理、查询和获取等操作，
 * 为系统提供多语言支持的核心服务。
 */
package com.hsxxherp.key.support.i18n.service;

import com.baomidou.mybatisplus.extension.service.IService;
import java.util.Map;

/**
 * II18nResourceService 是一个国际化资源服务接口，继承自 MyBatis-Plus 的 IService 接口，
 * 提供了对国际化资源进行管理和查询的相关方法。
 * 该接口定义了获取特定语言环境下的国际化消息以及获取所有国际化消息的方法。
 *
 * @param <I18nResource> 国际化资源实体类型，泛型参数用于指定该服务操作的具体实体类型。
 */
public interface II18nResourceService<I18nResource> extends IService<I18nResource> {

    /**
     * 根据语言代码和资源代码获取对应的国际化消息。
     *
     * @param localeCode   语言代码，用于指定语言环境，例如 "zh_CN" 表示中文（中国），"en_US" 表示英文（美国）。
     * @param resourceCode 资源代码，用于标识具体的国际化资源，在系统中唯一对应一条国际化消息。
     * @return 对应的国际化消息字符串，如果未找到匹配的消息则返回 null。
     */
    String getMessageByLocaleCodeAndResourceCode(String localeCode, String resourceCode);

    /**
     * 获取所有的国际化消息。
     *
     * @return 一个包含所有国际化消息的映射，键为资源代码，值为对应的国际化消息字符串。
     */
    Map<String, String> getAllMessages();
}